Skip to content

SphinxDocs set up #572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

SphinxDocs set up #572

wants to merge 14 commits into from

Conversation

sekyondaMeta
Copy link

Creating a sphinx site for the monarch docs

Example mock ups:
Screenshot 2025-07-17 at 16 51 18
Screenshot 2025-07-17 at 16 51 30

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jul 17, 2025
@@ -0,0 +1,52 @@
name: Docs
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add .DS_Store to .gitignore, and any sphinx related build files, like _build/ build/?

@@ -0,0 +1,98 @@
import os
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain why this script is needed?
I think you can do a much simpler setup for sphinx gallery and specify those in the conf.py. https://sphinx-gallery.github.io/stable/configuration.html


Here are some suggested steps to get started with Monarch:

1. **Installation**: Install Monarch using pip: `pip install torchmonarch-nightly`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting started has more detail on installation, so may just start with that and skip #1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants